mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
346 lines
No EOL
27 KiB
HTML
346 lines
No EOL
27 KiB
HTML
|
||
<!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/" />
|
||
|
||
<title>evennia.utils.evform — Evennia 1.0 documentation</title>
|
||
<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.utils.evmenu" href="evennia.utils.evmenu.html" />
|
||
<link rel="prev" title="evennia.utils.eveditor" href="evennia.utils.eveditor.html" />
|
||
</head><body>
|
||
<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.utils.evmenu.html" title="evennia.utils.evmenu"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.eveditor.html" title="evennia.utils.eveditor"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.utils.html" accesskey="U">evennia.utils</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.utils.evform</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<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.utils.eveditor.html"
|
||
title="previous chapter">evennia.utils.eveditor</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.utils.evmenu.html"
|
||
title="next chapter">evennia.utils.evmenu</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.utils.evform.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||
<li><a href="https://github.com/evennia/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>
|
||
</div>
|
||
</div>
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.utils.evform">
|
||
<span id="evennia-utils-evform"></span><h1>evennia.utils.evform<a class="headerlink" href="#module-evennia.utils.evform" title="Permalink to this headline">¶</a></h1>
|
||
<p>EvForm - a way to create advanced ASCII forms</p>
|
||
<p>This is intended for creating advanced ASCII game forms, such as a large pretty character sheet or
|
||
info document.</p>
|
||
<p>The system works on the basis of a readin template that is given in a separate Python file imported
|
||
into the handler. This file contains some optional settings and a string mapping out the form. The
|
||
template has markers in it to denounce fields to fill. The markers map the absolute size of the
|
||
field and will be filled with an <strong>evtable.EvCell</strong> object when displaying the form.</p>
|
||
<p>Example of input file <strong>testform.py</strong>:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">FORMCHAR</span> <span class="o">=</span> <span class="s2">"x"</span>
|
||
<span class="n">TABLECHAR</span> <span class="o">=</span> <span class="s2">"c"</span>
|
||
|
||
<span class="n">FORM</span> <span class="o">=</span> <span class="s1">'''</span>
|
||
<span class="s1">.------------------------------------------------.</span>
|
||
<span class="s1">| |</span>
|
||
<span class="s1">| Name: xxxxx1xxxxx Player: xxxxxxx2xxxxxxx |</span>
|
||
<span class="s1">| xxxxxxxxxxx |</span>
|
||
<span class="s1">| |</span>
|
||
<span class="s1"> >----------------------------------------------<</span>
|
||
<span class="s1">| |</span>
|
||
<span class="s1">| Desc: xxxxxxxxxxx STR: x4x DEX: x5x |</span>
|
||
<span class="s1">| xxxxx3xxxxx INT: x6x STA: x7x |</span>
|
||
<span class="s1">| xxxxxxxxxxx LUC: x8x MAG: x9x |</span>
|
||
<span class="s1">| |</span>
|
||
<span class="s1"> >----------------------------------------------<</span>
|
||
<span class="s1">| | |</span>
|
||
<span class="s1">| cccccccc | ccccccccccccccccccccccccccccccccccc |</span>
|
||
<span class="s1">| cccccccc | ccccccccccccccccccccccccccccccccccc |</span>
|
||
<span class="s1">| cccAcccc | ccccccccccccccccccccccccccccccccccc |</span>
|
||
<span class="s1">| cccccccc | ccccccccccccccccccccccccccccccccccc |</span>
|
||
<span class="s1">| cccccccc | cccccccccccccccccBccccccccccccccccc |</span>
|
||
<span class="s1">| | |</span>
|
||
<span class="s1">| v& |</span>
|
||
<span class="s1">-------------------------------------------------</span>
|
||
<span class="s1">'''</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The first line of the <strong>FORM</strong> string is ignored if empty. The forms and table markers must mark out
|
||
complete, unbroken rectangles, each containing one embedded single-character identifier (so the
|
||
smallest element possible is a 3-character wide form). The identifier can be any character except
|
||
for the <strong>FORM_CHAR</strong> and <strong>TABLE_CHAR</strong> and some of the common ASCII-art elements, like space, <strong>_</strong> <strong>|</strong>
|
||
<strong>*</strong> etc (see <strong>INVALID_FORMCHARS</strong> in this module). Form Rectangles can have any size, but must be
|
||
separated from each other by at least one other character’s width.</p>
|
||
<p>The form can also replace literal markers not abiding by these rules. For example, the <strong>v&</strong> in the
|
||
bottom right corner could be such literal marker. If a literal-mapping for ‘v&’ is provided, all
|
||
occurrences of this marker will be replaced. This will happen <em>before</em> any other parsing, so in
|
||
principle this could be used to inject new fields/tables into the form dynamically. This literal
|
||
mapping does not consider width, but it will affect to total width of the form, so make sure what
|
||
you inject does not break things. Using literal markers is the only way to inject 1 or 2-character
|
||
replacements.</p>
|
||
<p>Usage</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia</span> <span class="kn">import</span> <span class="n">EvForm</span><span class="p">,</span> <span class="n">EvTable</span>
|
||
|
||
<span class="c1"># create a new form from the template</span>
|
||
<span class="n">form</span> <span class="o">=</span> <span class="n">EvForm</span><span class="p">(</span><span class="s2">"path/to/testform.py"</span><span class="p">)</span>
|
||
|
||
<span class="c1"># alteratively, you can supply the template as a dict:</span>
|
||
|
||
<span class="n">form</span> <span class="o">=</span> <span class="n">EvForm</span><span class="p">({</span><span class="s2">"FORM"</span><span class="p">:</span> <span class="s2">"...."</span><span class="p">,</span> <span class="s2">"TABLECHAR"</span><span class="p">:</span> <span class="s2">"c"</span><span class="p">,</span> <span class="s2">"FORMCHAR"</span><span class="p">:</span> <span class="s2">"x"</span><span class="p">})</span>
|
||
|
||
<span class="c1"># EvForm can also take a dictionary instead of a filepath, as long</span>
|
||
<span class="c1"># as the dict contains the keys FORMCHAR, TABLECHAR and FORM</span>
|
||
<span class="c1"># form = EvForm(form=form_dict)</span>
|
||
|
||
<span class="c1"># add data to each tagged form cell</span>
|
||
<span class="n">form</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="n">cells</span><span class="o">=</span><span class="p">{</span><span class="mi">1</span><span class="p">:</span> <span class="s2">"Tom the Bouncer"</span><span class="p">,</span>
|
||
<span class="mi">2</span><span class="p">:</span> <span class="s2">"Griatch"</span><span class="p">,</span>
|
||
<span class="mi">3</span><span class="p">:</span> <span class="s2">"A sturdy fellow"</span><span class="p">,</span>
|
||
<span class="mi">4</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
|
||
<span class="mi">5</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
|
||
<span class="mi">6</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
|
||
<span class="mi">7</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
|
||
<span class="mi">8</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
|
||
<span class="mi">9</span><span class="p">:</span> <span class="mi">3</span><span class="p">})</span>
|
||
<span class="c1"># create the EvTables</span>
|
||
<span class="n">tableA</span> <span class="o">=</span> <span class="n">EvTable</span><span class="p">(</span><span class="s2">"HP"</span><span class="p">,</span><span class="s2">"MV"</span><span class="p">,</span><span class="s2">"MP"</span><span class="p">,</span>
|
||
<span class="n">table</span><span class="o">=</span><span class="p">[[</span><span class="s2">"**"</span><span class="p">],</span> <span class="p">[</span><span class="s2">"*****"</span><span class="p">],</span> <span class="p">[</span><span class="s2">"***"</span><span class="p">]],</span>
|
||
<span class="n">border</span><span class="o">=</span><span class="s2">"incols"</span><span class="p">)</span>
|
||
<span class="n">tableB</span> <span class="o">=</span> <span class="n">EvTable</span><span class="p">(</span><span class="s2">"Skill"</span><span class="p">,</span> <span class="s2">"Value"</span><span class="p">,</span> <span class="s2">"Exp"</span><span class="p">,</span>
|
||
<span class="n">table</span><span class="o">=</span><span class="p">[[</span><span class="s2">"Shooting"</span><span class="p">,</span> <span class="s2">"Herbalism"</span><span class="p">,</span> <span class="s2">"Smithing"</span><span class="p">],</span>
|
||
<span class="p">[</span><span class="mi">12</span><span class="p">,</span><span class="mi">14</span><span class="p">,</span><span class="mi">9</span><span class="p">],[</span><span class="s2">"550/1200"</span><span class="p">,</span> <span class="s2">"990/1400"</span><span class="p">,</span> <span class="s2">"205/900"</span><span class="p">]],</span>
|
||
<span class="n">border</span><span class="o">=</span><span class="s2">"incols"</span><span class="p">)</span>
|
||
<span class="c1"># map 'literal' replacents (here, a version string)</span>
|
||
<span class="n">custom_mapping</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"v&"</span><span class="p">,</span> <span class="s2">"v2"</span><span class="p">}</span>
|
||
|
||
<span class="c1"># add the tables to the proper ids in the form</span>
|
||
<span class="n">form</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="n">tables</span><span class="o">=</span><span class="p">{</span><span class="s2">"A"</span><span class="p">:</span> <span class="n">tableA</span><span class="p">,</span>
|
||
<span class="s2">"B"</span><span class="p">:</span> <span class="n">tableB</span><span class="p">})</span>
|
||
|
||
<span class="nb">print</span><span class="p">(</span><span class="n">form</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This produces the following result:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">.------------------------------------------------.</span>
|
||
<span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">Name</span><span class="p">:</span> <span class="n">Tom</span> <span class="n">the</span> <span class="n">Player</span><span class="p">:</span> <span class="n">Griatch</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">Bouncer</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">>----------------------------------------------<</span>
|
||
<span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">Desc</span><span class="p">:</span> <span class="n">A</span> <span class="n">sturdy</span> <span class="n">STR</span><span class="p">:</span> <span class="mi">12</span> <span class="n">DEX</span><span class="p">:</span> <span class="mi">10</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">fellow</span> <span class="n">INT</span><span class="p">:</span> <span class="mi">5</span> <span class="n">STA</span><span class="p">:</span> <span class="mi">18</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">LUC</span><span class="p">:</span> <span class="mi">10</span> <span class="n">MAG</span><span class="p">:</span> <span class="mi">3</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">>----------------------------------------------<</span>
|
||
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">HP</span><span class="o">|</span><span class="n">MV</span><span class="o">|</span><span class="n">MP</span> <span class="o">|</span> <span class="n">Skill</span> <span class="o">|</span><span class="n">Value</span> <span class="o">|</span><span class="n">Exp</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">~~+~~+~~</span> <span class="o">|</span> <span class="o">~~~~~~~~~~~+~~~~~~~~~~~+~~~~~~~~~~~</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">**|**|**</span> <span class="o">|</span> <span class="n">Shooting</span> <span class="o">|</span><span class="mi">12</span> <span class="o">|</span><span class="mi">550</span><span class="o">/</span><span class="mi">1200</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">|**|*</span> <span class="o">|</span> <span class="n">Herbalism</span> <span class="o">|</span><span class="mi">14</span> <span class="o">|</span><span class="mi">990</span><span class="o">/</span><span class="mi">1400</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">|*</span> <span class="o">|</span> <span class="o">|</span> <span class="n">Smithing</span> <span class="o">|</span><span class="mi">9</span> <span class="o">|</span><span class="mi">205</span><span class="o">/</span><span class="mi">900</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
|
||
<span class="o">|</span> <span class="n">v2</span> <span class="o">|</span>
|
||
<span class="o">------------------------------------------------</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The marked forms have been replaced with EvCells of text and with EvTables. The literal marker <strong>v&</strong>
|
||
was replaced with <strong>v2</strong>.</p>
|
||
<p>If you change the form layout on disk, you can use <strong>form.reload()</strong> to re-read it from disk without
|
||
creating a new form.</p>
|
||
<p>If you want to update the data of an existing form, you can use <strong>form.map()</strong> with the changes - the
|
||
mappings will be updated, keeping the things you want. You can also update the template itself this
|
||
way, by supplying it as a dict.</p>
|
||
<p>Each component (except literal mappings) is restrained to the width and height specified by the
|
||
template, so it will resize to fit (or crop text if the area is too small for it). If you try to fit
|
||
a table into an area it cannot fit into (when including its borders and at least one line of text),
|
||
the form will raise an error.</p>
|
||
<hr class="docutils" />
|
||
<dl class="py class">
|
||
<dt id="evennia.utils.evform.EvForm">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.evform.</code><code class="sig-name descname">EvForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cells</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tables</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">literals</span><span class="o">=</span><span class="default_value">None</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/utils/evform.html#EvForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.evform.EvForm" 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>
|
||
<p>This object is instantiated with a text file and parses
|
||
it for rectangular form fields. It can then be fed a
|
||
mapping so as to populate the fields with fixed-width
|
||
EvCell or Tables.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.utils.evform.EvForm.cell_options">
|
||
<code class="sig-name descname">cell_options</code><em class="property"> = {'align': 'l', 'enforce_size': True, 'pad_bottom': 0, 'pad_left': 0, 'pad_right': 0, 'pad_top': 0, 'valign': 't'}</em><a class="headerlink" href="#evennia.utils.evform.EvForm.cell_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.utils.evform.EvForm.table_options">
|
||
<code class="sig-name descname">table_options</code><em class="property"> = {'align': 'l', 'enforce_size': True, 'pad_bottom': 0, 'pad_left': 0, 'pad_right': 0, 'pad_top': 0, 'valign': 't'}</em><a class="headerlink" href="#evennia.utils.evform.EvForm.table_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.utils.evform.EvForm.__init__">
|
||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cells</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tables</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">literals</span><span class="o">=</span><span class="default_value">None</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/utils/evform.html#EvForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.evform.EvForm.__init__" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiate the form</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Keyword Arguments</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>data</strong> (<em>str</em><em> or </em><em>dict</em>) – Path to template file or a dict with
|
||
“formchar”, “tablechar” and “form” keys (not case sensitive, so FORM etc
|
||
also works, to stay compatible with the in-file names). While “form/FORM”
|
||
is required, if FORMCHAR/TABLECHAR are not given, they will default to
|
||
‘x’ and ‘c’ respectively.</p></li>
|
||
<li><p><strong>cells</strong> (<em>dict</em>) – A dictionary mapping <strong>{id: str}</strong></p></li>
|
||
<li><p><strong>tables</strong> (<em>dict</em>) – A dictionary mapping <strong>{id: EvTable}</strong>.</p></li>
|
||
<li><p><strong>literals</strong> (<em>dict</em>) – A dictionary mapping <strong>{id: str}</strong>. Will be replaced
|
||
after width of form is calculated, but before cells/tables are mapped.
|
||
All occurrences of the identifier on the form will be replaced. Note
|
||
that there is no length-restriction on the remap, you are responsible
|
||
for not breaking the form.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>Other kwargs are fed as options to the EvCells and EvTables
|
||
(see <strong>evtable.EvCell</strong> and <strong>evtable.EvTable</strong> for more info).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.utils.evform.EvForm.reload">
|
||
<code class="sig-name descname">reload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/evform.html#EvForm.reload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.evform.EvForm.reload" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates the form from a filename or data structure.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>data</strong> (<em>str</em><em> or </em><em>dict</em>) – Can be used to update an existing form using
|
||
the same cells/tables provided on initialization or using <strong>.map()</strong>.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>Kwargs are passed through to Cel creation.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.utils.evform.EvForm.map">
|
||
<code class="sig-name descname">map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cells</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tables</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">literals</span><span class="o">=</span><span class="default_value">None</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/utils/evform.html#EvForm.map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.evform.EvForm.map" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add mapping for form. This allows for updating an existing
|
||
evform.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cells</strong> (<em>dict</em>) – A dictionary of {identifier:celltext}. These
|
||
will be appended to the existing mappings.</p></li>
|
||
<li><p><strong>tables</strong> (<em>dict</em>) – A dictionary of {identifier:table}. Will
|
||
be appended to the existing mapping.</p></li>
|
||
<li><p><strong>data</strong> (<em>str</em><em> or </em><em>dict</em>) – A path to a evform module or a dict with
|
||
the needed “FORM”, “TABLE/FORMCHAR” keys. Will replace
|
||
the originally initialized form.</p></li>
|
||
<li><p><strong>literals</strong> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><p><strong>will be appended to the existing cell/table options.</strong> (<em>These</em>) – </p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>kwargs will be forwarded to tables/cells. See
|
||
<strong>evtable.EvCell</strong> and <strong>evtable.EvTable</strong> for info.</p>
|
||
</dd></dl>
|
||
|
||
</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.utils.evmenu.html" title="evennia.utils.evmenu"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.utils.eveditor.html" title="evennia.utils.eveditor"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.utils.html" >evennia.utils</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.utils.evform</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2022, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |