<spanid="evennia-contrib-full-systems-evscaperoom-utils"></span><h1>evennia.contrib.full_systems.evscaperoom.utils<aclass="headerlink"href="#module-evennia.contrib.full_systems.evscaperoom.utils"title="Permalink to this headline">¶</a></h1>
<p>Helper functions and classes for the evscaperoom contrib.</p>
<p>Most of these are available directly from wrappers in state/object/room classes
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><codeclass="sig-name descname">create_fantasy_word</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">length</span><spanclass="o">=</span><spanclass="default_value">5</span></em>, <emclass="sig-param"><spanclass="n">capitalize</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#create_fantasy_word"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.utils.create_fantasy_word"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a random semi-pronouncable ‘word’.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Keyword Arguments</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>length</strong> (<em>int</em>) – The desired length of the ‘word’.</p></li>
<li><p><strong>capitalize</strong> (<em>bool</em>) – If the return should be capitalized or not</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>word (str)</em>– The fictous word of given length.</p>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><codeclass="sig-name descname">parse_for_perspectives</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">string</span></em>, <emclass="sig-param"><spanclass="n">you</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#parse_for_perspectives"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.utils.parse_for_perspectives"title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a string with special markers to produce versions both
intended for the person doing the action (‘you’) and for those
seeing the person doing that action. Also marks ‘things’
according to style. See example below.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>string</strong> (<em>str</em>) – String on 2nd person form with ~ markers (‘~you ~open …’)</p></li>
<li><p><strong>you</strong> (<em>str</em>) – What others should see instead of you (Bob opens)</p></li>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><codeclass="sig-name descname">parse_for_things</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">string</span></em>, <emclass="sig-param"><spanclass="n">things_style</span><spanclass="o">=</span><spanclass="default_value">2</span></em>, <emclass="sig-param"><spanclass="n">clr</span><spanclass="o">=</span><spanclass="default_value">'|y'</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#parse_for_things"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.utils.parse_for_things"title="Permalink to this definition">¶</a></dt>
<dd><p>Parse string for special <ahref="#id1"><spanclass="problematic"id="id2">*</span></a>thing markers and decorate
it.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>string</strong> (<em>str</em>) – The string to parse.</p></li>
<li><p><strong>things_style</strong> (<em>int</em>) – The style to handle <strong>*things</strong> marked:
0 - no marking (remove <strong>*</strong>)
1 - mark with color
2 - mark with color and [] (default)</p></li>
<li><p><strong>clr</strong> (<em>str</em>) – Which color to use for marker..</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Example</p>
<p>You open <ahref="#id3"><spanclass="problematic"id="id4">*</span></a>door -> You open [door].</p>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><codeclass="sig-name descname">add_msg_borders</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#add_msg_borders"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.utils.add_msg_borders"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><codeclass="sig-name descname">msg_cinematic</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em>, <emclass="sig-param"><spanclass="n">borders</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#msg_cinematic"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.utils.msg_cinematic"title="Permalink to this definition">¶</a></dt>
<dd><p>Display a text as a ‘cinematic’ - centered and
surrounded by borders.</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 format.</p></li>
<li><p><strong>borders</strong> (<em>bool</em><em>, </em><em>optional</em>) – Put borders above and below text.</p></li>
