Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.server.connection_wizard.html

272 lines
18 KiB
HTML
Raw Normal View History

Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.server.connection_wizard &#8212; Evennia 2.x documentation</title>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.server.deprecations" href="evennia.server.deprecations.html" />
<link rel="prev" title="evennia.server.amp_client" href="evennia.server.amp_client.html" />
</head><body>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.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>
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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.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>
Updated HTML docs.
2023-06-10 08:53:19 +00:00
</div>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.server.amp_client.html"
title="previous chapter">evennia.server.amp_client</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.server.deprecations.html"
title="next chapter">evennia.server.deprecations</a></p>
<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>
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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="evennia.server.connection_wizard.html">2.x (main branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +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-11-15 20:29:38 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
</ul>
</div>
</div>
<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="Permalink to this headline"></a></h1>
<p>Link Evennia to external resources (wizard plugin for evennia_launcher)</p>
<dl class="py class">
<dt id="evennia.server.connection_wizard.ConnectionWizard">
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">ConnectionWizard</code><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard" title="Permalink 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 id="evennia.server.connection_wizard.ConnectionWizard.__init__">
<code class="sig-name descname">__init__</code><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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.__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.server.connection_wizard.ConnectionWizard.display">
<code class="sig-name descname">display</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#ConnectionWizard.display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.display" title="Permalink to this definition"></a></dt>
<dd><p>Show text</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.server.connection_wizard.ConnectionWizard.ask_continue">
<code class="sig-name descname">ask_continue</code><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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_continue" title="Permalink to this definition"></a></dt>
<dd><p>‘Press return to continue’-prompt</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.server.connection_wizard.ConnectionWizard.ask_node">
<code class="sig-name descname">ask_node</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">prompt</span><span class="o">=</span><span class="default_value">'Enter choice: '</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_node" title="Permalink 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</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 id="evennia.server.connection_wizard.ConnectionWizard.ask_yesno">
<code class="sig-name descname">ask_yesno</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prompt</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">'yes'</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_yesno" title="Permalink 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</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</dt>
<dd class="field-even"><p><em>reply (str)</em> – Either ‘yes’ or ‘no’.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.server.connection_wizard.ConnectionWizard.ask_choice">
<code class="sig-name descname">ask_choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prompt</span><span class="o">=</span><span class="default_value">' &gt; '</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_choice" title="Permalink 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</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> (<a class="reference internal" href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list" title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – 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</dt>
<dd class="field-even"><p><em>reply (str)</em> – The answered reply.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.server.connection_wizard.ConnectionWizard.ask_input">
<code class="sig-name descname">ask_input</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prompt</span><span class="o">=</span><span class="default_value">' &gt; '</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">validator</span><span class="o">=</span><span class="default_value">None</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.ConnectionWizard.ask_input" title="Permalink to this definition"></a></dt>
<dd><p>Get arbitrary input inline.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments</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</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 id="evennia.server.connection_wizard.node_start">
<code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">node_start</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wizard</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/connection_wizard.html#node_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="evennia.server.connection_wizard.node_game_index_start">
<code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">node_game_index_start</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wizard</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/server/connection_wizard.html#node_game_index_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_game_index_start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="evennia.server.connection_wizard.node_game_index_fields">
<code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">node_game_index_fields</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wizard</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_game_index_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="evennia.server.connection_wizard.node_mssp_start">
<code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">node_mssp_start</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wizard</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_mssp_start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="evennia.server.connection_wizard.node_view_and_apply_settings">
<code class="sig-prename descclassname">evennia.server.connection_wizard.</code><code class="sig-name descname">node_view_and_apply_settings</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wizard</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">[source]</span></a><a class="headerlink" href="#evennia.server.connection_wizard.node_view_and_apply_settings" title="Permalink to this definition"></a></dt>
<dd><p>Inspect and save the data gathered in the other nodes</p>
</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.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>
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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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.server.html" >evennia.server</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.connection_wizard</a></li>
</ul>
</div>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="footer" role="contentinfo">
Updated HTML docs.
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01: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