Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-21 23:36:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.server.connection_wizard.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

310 lines
No EOL
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.server.connection_wizard &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="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.server.deprecations" href="evennia.server.deprecations.html" />
<link rel="prev" title="evennia.server.amp_client" href="evennia.server.amp_client.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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.server.deprecations.html" title="evennia.server.deprecations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.server.amp_client.html" title="evennia.server.amp_client"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<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.server.html" accesskey="U">evennia.server</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.connection_wizard</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.server.connection_wizard">
<span id="evennia-server-connection-wizard"></span><h1>evennia.server.connection_wizard<a class="headerlink" href="#module-evennia.server.connection_wizard" title="Link to this heading"></a></h1>
<p>Link Evennia to external resources (wizard plugin for evennia_launcher)</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">ConnectionWizard</span></span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.display">
<span class="sig-name descname"><span class="pre">display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.display"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.display" title="Link to this definition"></a></dt>
<dd><p>Show text</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.ask_continue">
<span class="sig-name descname"><span class="pre">ask_continue</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.ask_continue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_continue" title="Link to this definition"></a></dt>
<dd><p>‘Press return to continue’-prompt</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.ask_node">
<span class="sig-name descname"><span class="pre">ask_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prompt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Enter</span> <span class="pre">choice:</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.ask_node"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_node" title="Link to this definition"></a></dt>
<dd><p>Retrieve options and jump to different menu nodes</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>options</strong> (<em>dict</em>) – Node options on the form {key: (desc, callback), }</p></li>
<li><p><strong>prompt</strong> (<em>str</em><em>, </em><em>optional</em>) – Question to ask</p></li>
<li><p><strong>default</strong> (<em>str</em><em>, </em><em>optional</em>) – Default value to use if user hits return.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.ask_yesno">
<span class="sig-name descname"><span class="pre">ask_yesno</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prompt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'yes'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.ask_yesno"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_yesno" title="Link to this definition"></a></dt>
<dd><p>Ask a yes/no question inline.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>prompt</strong> (<em>str</em>) – The prompt to ask.</p></li>
<li><p><strong>default</strong> (<em>str</em>) – “yes” or “no”, used if pressing return.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>reply (str)</em> – Either ‘yes’ or ‘no’.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.ask_choice">
<span class="sig-name descname"><span class="pre">ask_choice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prompt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">&gt;</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.ask_choice"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_choice" title="Link to this definition"></a></dt>
<dd><p>Ask multiple-choice question, get response inline.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>prompt</strong> (<em>str</em>) – Input prompt.</p></li>
<li><p><strong>options</strong> (<em>list</em>) – List of options. Will be indexable by sequence number 1…</p></li>
<li><p><strong>default</strong> (<em>int</em>) – The list index+1 of the default choice, if any</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>reply (str)</em> – The answered reply.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.ConnectionWizard.ask_input">
<span class="sig-name descname"><span class="pre">ask_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prompt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">&gt;</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.ask_input"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_input" title="Link to this definition"></a></dt>
<dd><p>Get arbitrary input inline.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>prompt</strong> (<em>str</em>) – The display prompt.</p></li>
<li><p><strong>default</strong> (<em>str</em>) – If empty input, use this.</p></li>
<li><p><strong>validator</strong> (<em>callable</em>) – If given, the input will be passed
into this callable. It should return True unless validation
fails (and is expected to echo why if so).</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>inp (str)</em> – The input given, or default.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.node_start">
<span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">node_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wizard</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_start" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.node_game_index_start">
<span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">node_game_index_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wizard</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_game_index_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_game_index_start" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.node_game_index_fields">
<span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">node_game_index_fields</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wizard</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_game_index_fields"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_game_index_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.node_mssp_start">
<span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">node_mssp_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wizard</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_mssp_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_mssp_start" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.server.connection_wizard.node_view_and_apply_settings">
<span class="sig-prename descclassname"><span class="pre">evennia.server.connection_wizard.</span></span><span class="sig-name descname"><span class="pre">node_view_and_apply_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wizard</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_view_and_apply_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_view_and_apply_settings" title="Link to this definition"></a></dt>
<dd><p>Inspect and save the data gathered in the other nodes</p>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.server.connection_wizard</a><ul>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard</span></code></a><ul>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.__init__"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.display"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.display()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.ask_continue"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.ask_continue()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.ask_node"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.ask_node()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.ask_yesno"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.ask_yesno()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.ask_choice"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.ask_choice()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.ConnectionWizard.ask_input"><code class="docutils literal notranslate"><span class="pre">ConnectionWizard.ask_input()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.node_start"><code class="docutils literal notranslate"><span class="pre">node_start()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.node_game_index_start"><code class="docutils literal notranslate"><span class="pre">node_game_index_start()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.node_game_index_fields"><code class="docutils literal notranslate"><span class="pre">node_game_index_fields()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.node_mssp_start"><code class="docutils literal notranslate"><span class="pre">node_mssp_start()</span></code></a></li>
<li><a class="reference internal" href="#evennia.server.connection_wizard.node_view_and_apply_settings"><code class="docutils literal notranslate"><span class="pre">node_view_and_apply_settings()</span></code></a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.server.amp_client.html"
title="previous chapter">evennia.server.amp_client</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.server.deprecations.html"
title="next chapter">evennia.server.deprecations</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.server.connection_wizard.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<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>
<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>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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.server.deprecations.html" title="evennia.server.deprecations"
>next</a> |</li>
<li class="right" >
<a href="evennia.server.amp_client.html" title="evennia.server.amp_client"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<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.server.html" >evennia.server</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.connection_wizard</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink