<spanid="evennia-contrib-full-systems-evscaperoom-menu"></span><h1>evennia.contrib.full_systems.evscaperoom.menu<aclass="headerlink"href="#module-evennia.contrib.full_systems.evscaperoom.menu"title="Permalink to this headline">¶</a></h1>
<p>Start menu</p>
<p>This is started from the <strong>evscaperoom</strong> command.</p>
<p>Here player user can set their own description as well as select to create a
new room (to start from scratch) or join an existing room (with other players).</p>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">node_set_desc</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_set_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.node_set_desc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">node_create_room</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_create_room"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.node_create_room"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">node_join_room</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_join_room"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.node_join_room"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">node_quit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_quit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.node_quit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">node_border_char</code><emclass="property"> = '~'</em><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.node_border_char"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">nodetext_formatter</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/menu.html#EvscaperoomMenu.nodetext_formatter"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.nodetext_formatter"title="Permalink to this definition">¶</a></dt>
<dd><p>Format the node text itself.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>nodetext</strong> (<em>str</em>) – The full node text (the text describing the node).</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>nodetext (str)</em>– The formatted node text.</p>
<codeclass="sig-name descname">options_formatter</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">optionlist</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#EvscaperoomMenu.options_formatter"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.options_formatter"title="Permalink to this definition">¶</a></dt>
<dd><p>Formats the option block.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>optionlist</strong> (<em>list</em>) – List of (key, description) tuples for every
option related to this node.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>options (str)</em>– The formatted option display.</p>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">run_evscaperoom_menu</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#run_evscaperoom_menu"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.run_evscaperoom_menu"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">node_options</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_options"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.node_options"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">node_formatter</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">nodetext</span></em>, <emclass="sig-param"><spanclass="n">optionstext</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#OptionsMenu.node_formatter"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.OptionsMenu.node_formatter"title="Permalink to this definition">¶</a></dt>
<dd><p>Formats the entirety of the node.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>nodetext</strong> (<em>str</em>) – The node text as returned by <strong>self.nodetext_formatter</strong>.</p></li>
<li><p><strong>optionstext</strong> (<em>str</em>) – The options display as returned by <strong>self.options_formatter</strong>.</p></li>
<li><p><strong>caller</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – The caller of the node.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>node (str)</em>– The formatted node to display.</p>
<codeclass="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><codeclass="sig-name descname">run_option_menu</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">session</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#run_option_menu"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.full_systems.evscaperoom.menu.run_option_menu"title="Permalink to this definition">¶</a></dt>