<spanid="evennia-contrib-base-systems-godotwebsocket-text2bbcode"></span><h1>evennia.contrib.base_systems.godotwebsocket.text2bbcode<aclass="headerlink"href="#module-evennia.contrib.base_systems.godotwebsocket.text2bbcode"title="Permalink to this headline">¶</a></h1>
<p>Godot Websocket - ChrisLR 2022</p>
<p>This file contains the necessary code and data to convert text with color tags to bbcode (For godot)</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">RootTag</code><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#RootTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.RootTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#RootTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.RootTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.RootTag.child"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">ChildTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#ChildTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ChildTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#ChildTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ChildTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">set_parent</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#ChildTag.set_parent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ChildTag.set_parent"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">TextTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">text</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextTag.text"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextTag.child"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextTag.parent"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">BBCodeTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#BBCodeTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BBCodeTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = ''</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BBCodeTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#BBCodeTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BBCodeTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BBCodeTag.child"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BBCodeTag.parent"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">UnderlineTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#UnderlineTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UnderlineTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = 'u'</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UnderlineTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UnderlineTag.parent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UnderlineTag.child"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">BlinkTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#BlinkTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BlinkTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = 'blink'</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BlinkTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BlinkTag.parent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BlinkTag.child"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">ColorTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">color_hex</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#ColorTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = 'color'</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">color_hex</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#ColorTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">color_hex</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag.color_hex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag.parent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.ColorTag.child"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">BGColorTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">color_hex</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#BGColorTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BGColorTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = 'bgcolor'</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BGColorTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BGColorTag.parent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BGColorTag.child"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">color_hex</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.BGColorTag.color_hex"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">UrlTag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">url_data</span><spanclass="o">=</span><spanclass="default_value">''</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#UrlTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">code</code><emclass="property"> = 'url'</em><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag.code"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent</span></em>, <emclass="sig-param"><spanclass="n">url_data</span><spanclass="o">=</span><spanclass="default_value">''</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#UrlTag.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag.__init__"title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
<codeclass="sig-name descname">url_data</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag.url_data"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parent</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag.parent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">child</code><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.UrlTag.child"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">TextToBBCODEparser</code><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">convert_urls</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.convert_urls"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.convert_urls"title="Permalink to this definition">¶</a></dt>
<dd><p>Converts urls within text to bbcode style</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>text</strong> (<em>str</em>) – Text to parse</p>
<codeclass="sig-name descname">sub_mxp_links</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.sub_mxp_links"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.sub_mxp_links"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper method to be passed to re.sub,
replaces MXP links with bbcode.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>match</strong> (<em>re.Matchobject</em>) – Match for substitution.</p>
<codeclass="sig-name descname">sub_mxp_urls</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.sub_mxp_urls"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.sub_mxp_urls"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sub_text</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">match</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.sub_text"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.sub_text"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper method to be passed to re.sub,
for handling all substitutions.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>match</strong> (<em>re.Matchobject</em>) – Match for substitution.</p>
<codeclass="sig-name descname">format_styles</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.format_styles"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.format_styles"title="Permalink to this definition">¶</a></dt>
<dd><p>Takes a string with parsed ANSI codes and replaces them with bbcode style tags</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>text</strong> (<em>str</em>) – The string to process.</p>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em>, <emclass="sig-param"><spanclass="n">strip_ansi</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#TextToBBCODEparser.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>Main access function, converts a text containing ANSI codes
into html statements.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>text</strong> (<em>str</em>) – Text to process.</p></li>
<codeclass="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.text2bbcode.</code><codeclass="sig-name descname">parse_to_bbcode</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em>, <emclass="sig-param">strip_ansi=False</em>, <emclass="sig-param">parser=<evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser object></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/base_systems/godotwebsocket/text2bbcode.html#parse_to_bbcode"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.base_systems.godotwebsocket.text2bbcode.parse_to_bbcode"title="Permalink to this definition">¶</a></dt>
<dd><p>Parses a string, replace ANSI markup with bbcode</p>