Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 12:37:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.contrib.rpg.character_creator.character_creator.html

281 lines
19 KiB
HTML
Raw Normal View History

Updated HTML docs.
2022-11-20 23:39:28 +00: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.contrib.rpg.character_creator.character_creator &#8212; Evennia 2.x documentation</title>
Updated HTML docs.
2022-11-20 23:39:28 +00: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.contrib.rpg.character_creator.example_menu" href="evennia.contrib.rpg.character_creator.example_menu.html" />
<link rel="prev" title="evennia.contrib.rpg.character_creator" href="evennia.contrib.rpg.character_creator.html" />
</head><body>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Updated HTML docs.
2022-11-20 23:39:28 +00: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.contrib.rpg.character_creator.example_menu.html" title="evennia.contrib.rpg.character_creator.example_menu"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.rpg.character_creator.html" title="evennia.contrib.rpg.character_creator"
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>
Updated HTML docs.
2022-11-20 23:39:28 +00: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.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.rpg.html" >evennia.contrib.rpg</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.rpg.character_creator.html" accesskey="U">evennia.contrib.rpg.character_creator</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.rpg.character_creator.character_creator</a></li>
</ul>
Updated HTML docs.
2023-06-10 08:53:19 +00:00
</div>
Updated HTML docs.
2022-11-20 23:39:28 +00: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>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.rpg.character_creator.character_creator</a><ul>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.rpg.character_creator.html"
title="previous chapter">evennia.contrib.rpg.character_creator</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.rpg.character_creator.example_menu.html"
title="next chapter">evennia.contrib.rpg.character_creator.example_menu</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.rpg.character_creator.character_creator.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>
Updated HTML docs.
2022-11-20 23:39:28 +00: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>
Updated HTML docs.
2022-11-20 23:39:28 +00:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="evennia.contrib.rpg.character_creator.character_creator.html">2.x (main branch)</a></li>
Updated HTML docs.
2022-11-20 23:39:28 +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-20 23:39:28 +00:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.rpg.character_creator.character_creator">
<span id="evennia-contrib-rpg-character-creator-character-creator"></span><h1>evennia.contrib.rpg.character_creator.character_creator<a class="headerlink" href="#module-evennia.contrib.rpg.character_creator.character_creator" title="Permalink to this headline"></a></h1>
<p>Character Creator contrib, by InspectorCaracal</p>
<section id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<p>The primary feature of this contrib is defining the name and attributes
of a new character through an EvMenu. It provides an alternate <strong>charcreate</strong>
command as well as a modified <strong>at_look</strong> method for your Account class.</p>
</section>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>In order to use the contrib, you will need to create your own chargen
EvMenu. The included <strong>example_menu.py</strong> gives a number of useful techniques
and examples, including how to allow players to choose and confirm
character names from within the menu.</p>
<dl class="py class">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.rpg.character_creator.character_creator.</code><code class="sig-name descname">ContribCmdCharCreate</code><span class="sig-paren">(</span><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/contrib/rpg/character_creator/character_creator.html#ContribCmdCharCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxAccountCommand" title="evennia.commands.default.muxcommand.MuxAccountCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxAccountCommand</span></code></a></p>
<p>create a new character</p>
<p>Begin creating a new character, or resume character creation for
an existing in-progress character.</p>
<p>You can stop character creation at any time and resume where
you left off later.</p>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.key">
<code class="sig-name descname">key</code><em class="property"> = 'charcreate'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player) and is_ooc()'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/rpg/character_creator/character_creator.html#ContribCmdCharCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.func" title="Permalink to this definition"></a></dt>
<dd><p>create the new character</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player) and is_ooc()'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'charcreate', 'no_prefix': ' ', 'tags': '', 'text': '\n create a new character\n\n Begin creating a new character, or resume character creation for\n an existing in-progress character.\n\n You can stop character creation at any time and resume where\n you left off later.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribCmdCharCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.rpg.character_creator.character_creator.</code><code class="sig-name descname">ContribChargenAccount</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</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/contrib/rpg/character_creator/character_creator.html#ContribChargenAccount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount</span></code></a></p>
<p>A modified Account class that makes minor changes to the OOC look
output, to incorporate in-progress characters.</p>
<dl class="py method">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.at_look">
<code class="sig-name descname">at_look</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">session</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/contrib/rpg/character_creator/character_creator.html#ContribChargenAccount.at_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.at_look" title="Permalink to this definition"></a></dt>
<dd><p>Called by the OOC look command. It displays a list of playable
characters and should be mostly identical to the core method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>target</strong> (<em>Object</em><em> or </em><em>list</em><em>, </em><em>optional</em>) – An object or a list
objects to inspect.</p></li>
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – The session doing this look.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><em>look_string (str)</em> –</p>
<dl class="simple">
<dt>A prepared look string, ready to send</dt><dd><p>off to any recipient (usually to ourselves)</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount.DoesNotExist" title="evennia.accounts.accounts.DefaultAccount.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount.MultipleObjectsReturned" title="evennia.accounts.accounts.DefaultAccount.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'ContribChargenAccount'</em><a class="headerlink" href="#evennia.contrib.rpg.character_creator.character_creator.ContribChargenAccount.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</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.contrib.rpg.character_creator.example_menu.html" title="evennia.contrib.rpg.character_creator.example_menu"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.rpg.character_creator.html" title="evennia.contrib.rpg.character_creator"
>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>
Updated HTML docs.
2022-11-20 23:39:28 +00: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.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.rpg.html" >evennia.contrib.rpg</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.rpg.character_creator.html" >evennia.contrib.rpg.character_creator</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.rpg.character_creator.character_creator</a></li>
</ul>
</div>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Updated HTML docs.
2022-11-20 23:39:28 +00:00
<div class="footer" role="contentinfo">
Updated HTML docs.
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Updated HTML docs.
2022-11-20 23:39:28 +00: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